Skip to main content

VisualControl

The VisualControl class represents a base visual control with properties related to visibility, styling, and interactivity.

Properties

NameDescription
ContextMenuColumnKeyThe key of the column associated with the context menu.
CaptionThe caption of the control.
LoadingIndicates whether the control is in a loading state.
ControlIdThe unique identifier of the control.
StyleThe styling properties for the control.
ClientEventsA list of client-side events associated with the control.
ContextMenuTargetThe target of the context menu.
TitleThe title of the control.
ExecutedServerEventsA list of server events that have been executed.
NameThe name of the control.
VisibleIndicates whether the control is visible.
ClientVisibleIndicates whether the control is visible on the client side.
ServerEventsA list of server-side events associated with the control.
DefaultClientEnabledIndicates whether the control is enabled by default on the client side.
ClientEnabledIndicates whether the control is enabled on the client side.
EnabledIndicates whether the control is enabled.
ContextMenuKeyThe key associated with the context menu.
ContainerStyleThe styling properties for the container of the control.
CustomClassNameThe custom CSS class name applied to the control.
DefaultEnabledIndicates whether the control is enabled by default.

Constructors

NameDescription
BaseControl()Initializes a new instance of the VisualControl class with default values.
VisualControl()Initializes a new instance of the VisualControl class with empty event lists.

Methods

NameDescription
ScrollTo()Scrolls to the control.
HideLoading()Removes the loading state from the control.
FireClick()Triggers the Click event.
OnInit(sender, e)Raises the Init event.
Hide()Hides the control.
OnPropertyValueGet(sender, e)Raises the PropertyValueGet event.
Show()Makes the control visible.
OnRender(sender, e)Raises the Render event.
OnLoad(sender, e)Raises the Load event.
GetProtectedData(isDisabledOrReadOnly)#import (Bimser.CSP.FormControls.Base.ICanProtectData.GetProtectedData(bool)) (shortDescription)
ToggleLoading()Toggles the loading state of the control.
GetDifferences(otherObj)Compares the current instance with another control and returns the differences.
SetPropertyValue(mapping, value)Sets the value of a property specified by a mapping.
OnPropertyChanged(sender, e)Handles the property changed event.
ShowLoading()Sets the control to a loading state.
OnPreRender(sender, e)Raises the PreRender event.
OnPropertyChanging(sender, e)Handles the property changing event.
OnDoubleClick(sender, e)Raises the DoubleClick event.
OnClick(sender, e)Raises the Click event.

Events

NameDescription
InitTriggered when the control is initialized.
LoadTriggered when the control is loaded.
DoubleClickTriggered when the control is double-clicked.
PreRenderTriggered before the control is rendered.
PropertyValueGetTriggered when retrieving a control property value.
ClickTriggered when the control is clicked.
RenderTriggered when the control is rendered.